/*
 * The contents of this web application are subject to the Mozilla Public License Version 
 * 1.1 (the "License"); you may not use this web application except in compliance with 
 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
 * for the specific language governing rights and limitations under the License.
 * 
 * The Original Code is owned by and the Initial Developer of the Original Code is 
 * Composite A/S (Danish business reg.no. 21744409). All Rights Reserved
 * 
 * Section 11 of the License is EXPRESSLY amended to include a provision stating 
 * that any dispute, including but not limited to disputes related to the enforcement 
 * of the License, to which Composite A/S as owner of the Original Code, as Initial 
 * Developer or in any other role, becomes a part to shall be governed by Danish law 
 * and be initiated before the Copenhagen City Court ("K�benhavns Byret")            
 */

using System.Collections.Generic;
using Composite.C1Console.Security.Plugins.LoginProvider.Runtime;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration.ObjectBuilder;


namespace Composite.C1Console.Security.Plugins.LoginProvider
{
    /// <summary>
    /// Base interface for login providers.
    /// </summary>
    [CustomFactory(typeof(LoginProviderCustomFactory))]
    [ConfigurationNameMapper(typeof(LoginProviderDefaultNameRetriever))]
    public interface ILoginProvider
    {
        /// <summary>
        /// Enumerates all known user names
        /// </summary>
        IEnumerable<string> AllUsernames { get; }

        /// <summary>
        /// When true the provider is capable of changing a users password
        /// </summary>
        bool CanSetUserPassword { get; }

        /// <summary>
        /// When true the provider is capable of creating new users
        /// </summary>
        bool CanAddNewUser { get; }

        /// <summary>
        /// When true users exists in the system, i.e. AllUsernames.Any()
        /// </summary>
        bool UsersExists { get; }
    }
}